<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Class bmqt::QueueOptions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="bdedox.css" rel="stylesheet" type="text/css"/>
    <style>
      div.hanging {
        padding-left: 0.75in;
        text-indent: -0.50in;
      }
      div.unhanging {
        text-indent:     0in;
      }
      a.glossary {
        font-weight: bold;
        font-style: italic;
      }
    </style>
</head>
<!--
<body onload='searchBox.OnSelectItem(0);'>
-->
<body>

<table border=2 cellspacing=0 cellpadding=0 align=center>
<tr>
 <td valign=top align=center>
 <p align=center><b><i>Quick Links:</i></b></p>
 </td>
 <td valign=top align=center>
 <p align=center>
<a class="qindex" href="group__bmqa.html" target="_blank">bmqa</a> | <a class="qindex" href="group__bmqpi.html" target="_blank">bmqpi</a> | <a class="qindex" href="group__bmqt.html" target="_blank">bmqt</a>
 </td>
 </tr>
 </table>

  </div>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul class="tablist">
      <li><a href="components.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="components.html"><span>Components</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath">
    <ul>
      <li><a class="el" href="namespacebmqt.html">bmqt</a>      </li>
      <li><a class="el" href="classbmqt_1_1QueueOptions.html">bmqt::QueueOptions</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a>  </div>
  <div class="headertitle">
<h1>bmqt::QueueOptions Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="bmqt::QueueOptions" -->
<p><code>#include &lt;<a class="el" href="bmqt__queueoptions_8h_source.html">bmqt_queueoptions.h</a>&gt;</code></p>

<p><a href="classbmqt_1_1QueueOptions-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef bsl::pair<br class="typebreak"/>
&lt; <a class="el" href="classbmqt_1_1SubscriptionHandle.html">SubscriptionHandle</a>, <br class="typebreak"/>
<a class="el" href="classbmqt_1_1Subscription.html">Subscription</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#acd64aca45d49efb8b31e75084c39a135">HandleAndSubscription</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef bsl::vector<br class="typebreak"/>
&lt; <a class="el" href="classbmqt_1_1QueueOptions.html#acd64aca45d49efb8b31e75084c39a135">HandleAndSubscription</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a9c1e8d991cf21dbb0653f991cf2fa432">SubscriptionsSnapshot</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#ab68ced4970f5d55eae8c8f4de939e007">QueueOptions</a> (bslma::Allocator *allocator=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a8441bbf5dfdbd879b423374b1fd9c297">QueueOptions</a> (const <a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a> &amp;other, bslma::Allocator *allocator=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a21b81f93c387cb65e65bf05255c00594">setMaxUnconfirmedMessages</a> (int value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#ad7ef225e8e1eafdb532838bea558d5bf">setMaxUnconfirmedBytes</a> (int value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a36c8893949cd3f77df95f244989decd9">setConsumerPriority</a> (int value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a47cae3df6a3252c769244946890e430f">setSuspendsOnBadHostHealth</a> (bool value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a0047c64c5664f6d4aca4f89ec3471c40">merge</a> (const <a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a> &amp;other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a2b19890736f81ae192ab0bdad5192284">addOrUpdateSubscription</a> (bsl::string *errorDescription, const <a class="el" href="classbmqt_1_1SubscriptionHandle.html">SubscriptionHandle</a> &amp;handle, const <a class="el" href="classbmqt_1_1Subscription.html">Subscription</a> &amp;subscription)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#ab15f2fcc557e49a769ad63489bc64a96">removeSubscription</a> (const <a class="el" href="classbmqt_1_1SubscriptionHandle.html">SubscriptionHandle</a> &amp;handle)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#ae8715c8c8dde82a208aec81d1b23ac8b">removeAllSubscriptions</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#afefffe95ececcd836bf25a8ca81795d3">maxUnconfirmedMessages</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#af9ea60251d07f84aa5a0ef02689c391a">maxUnconfirmedBytes</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#aa832b2acfb752a6b83a3af8974c2547b">consumerPriority</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a6d2c1d8572f5ec608f2dc3121a24c60c">suspendsOnBadHostHealth</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a66954bd9a55ad76d630dae6c9d1ee203">hasMaxUnconfirmedMessages</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a5c2da6dca1f318ebcde64bd8cb07e87e">hasMaxUnconfirmedBytes</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a1ad5325eed0d04a642e83e9ca61d9459">hasConsumerPriority</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#ab9c911994c74f86d1b9d038c66f98016">hasSuspendsOnBadHostHealth</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a166fc25291cde329afbcbb1f2679fe6f">loadSubscription</a> (<a class="el" href="classbmqt_1_1Subscription.html">Subscription</a> *subscription, const <a class="el" href="classbmqt_1_1SubscriptionHandle.html">SubscriptionHandle</a> &amp;handle) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a19d8ed9af8de3110a24e06943c24d75c">loadSubscriptions</a> (<a class="el" href="classbmqt_1_1QueueOptions.html#a9c1e8d991cf21dbb0653f991cf2fa432">SubscriptionsSnapshot</a> *snapshot) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bsl::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a914fedf6006eb0d656ef62e35bbf32b6">print</a> (bsl::ostream &amp;stream, int level=0, int spacesPerLevel=4) const </td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a38adf91bbaa3db9053f91f2379932948">k_CONSUMER_PRIORITY_MIN</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a9a92dfabe30fb12dde00aa9303d7ed84">k_CONSUMER_PRIORITY_MAX</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#aabe15a2964a14ff88ee44341f72c416a">k_DEFAULT_MAX_UNCONFIRMED_MESSAGES</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#a9f6446c7c8924842bab804fe66905fac">k_DEFAULT_MAX_UNCONFIRMED_BYTES</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#adfa0750ed97f9aea50c5f1f3125d4e00">k_DEFAULT_CONSUMER_PRIORITY</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1QueueOptions.html#aaa822bd525767bd9f5cc6ec35cb55db3">k_DEFAULT_SUSPENDS_ON_BAD_HOST_HEALTH</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Value-semantic type for options related to a queue.</p>
<p>See <a class="el" href="group__bmqt__queueoptions.html">Component bmqt_queueoptions</a> </p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="acd64aca45d49efb8b31e75084c39a135"></a><!-- doxytag: member="bmqt::QueueOptions::HandleAndSubscription" ref="acd64aca45d49efb8b31e75084c39a135" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef bsl::pair&lt;<a class="el" href="classbmqt_1_1SubscriptionHandle.html">SubscriptionHandle</a>, <a class="el" href="classbmqt_1_1Subscription.html">Subscription</a>&gt; <a class="el" href="classbmqt_1_1QueueOptions.html#acd64aca45d49efb8b31e75084c39a135">bmqt::QueueOptions::HandleAndSubscription</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a9c1e8d991cf21dbb0653f991cf2fa432"></a><!-- doxytag: member="bmqt::QueueOptions::SubscriptionsSnapshot" ref="a9c1e8d991cf21dbb0653f991cf2fa432" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef bsl::vector&lt;<a class="el" href="classbmqt_1_1QueueOptions.html#acd64aca45d49efb8b31e75084c39a135">HandleAndSubscription</a>&gt; <a class="el" href="classbmqt_1_1QueueOptions.html#a9c1e8d991cf21dbb0653f991cf2fa432">bmqt::QueueOptions::SubscriptionsSnapshot</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab68ced4970f5d55eae8c8f4de939e007"></a><!-- doxytag: member="bmqt::QueueOptions::QueueOptions" ref="ab68ced4970f5d55eae8c8f4de939e007" args="(bslma::Allocator *allocator=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqt::QueueOptions::QueueOptions </td>
          <td>(</td>
          <td class="paramtype">bslma::Allocator *&nbsp;</td>
          <td class="paramname"> <em>allocator</em> = <code>0</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Create a new <a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a> using the optionally specified <code>allocator</code>. </p>

</div>
</div>
<a class="anchor" id="a8441bbf5dfdbd879b423374b1fd9c297"></a><!-- doxytag: member="bmqt::QueueOptions::QueueOptions" ref="a8441bbf5dfdbd879b423374b1fd9c297" args="(const QueueOptions &amp;other, bslma::Allocator *allocator=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqt::QueueOptions::QueueOptions </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>other</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bslma::Allocator *&nbsp;</td>
          <td class="paramname"> <em>allocator</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Create a new <a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a> by copying values from the specified <code>other</code>, using the optionally specified <code>allocator</code>. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a21b81f93c387cb65e65bf05255c00594"></a><!-- doxytag: member="bmqt::QueueOptions::setMaxUnconfirmedMessages" ref="a21b81f93c387cb65e65bf05255c00594" args="(int value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a>&amp; bmqt::QueueOptions::setMaxUnconfirmedMessages </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>value</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set the maxUnconfirmedMessages to the specified <code>value</code>. The behavior is undefined unless <code>value &gt;= 0</code>. If the specified <code>value</code> is set to 0, it means that the consumer does not receive any messages. This might be useful when the consumer is shutting down and wants to process only pending messages, or when it is unable to process new messages because of transient issues. </p>

</div>
</div>
<a class="anchor" id="ad7ef225e8e1eafdb532838bea558d5bf"></a><!-- doxytag: member="bmqt::QueueOptions::setMaxUnconfirmedBytes" ref="ad7ef225e8e1eafdb532838bea558d5bf" args="(int value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a>&amp; bmqt::QueueOptions::setMaxUnconfirmedBytes </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>value</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set the maxUnconfirmedBytes to the specified <code>value</code>. The behavior is undefined unless <code>value &gt;= 0</code>. </p>

</div>
</div>
<a class="anchor" id="a36c8893949cd3f77df95f244989decd9"></a><!-- doxytag: member="bmqt::QueueOptions::setConsumerPriority" ref="a36c8893949cd3f77df95f244989decd9" args="(int value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a>&amp; bmqt::QueueOptions::setConsumerPriority </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>value</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set the consumerPriority to the specified <code>value</code>. The behavior is undefined unless 'k_CONSUMER_PRIORITY_MIN &lt;= value &lt;= k_CONSUMER_PRIORITY_MAX' </p>

</div>
</div>
<a class="anchor" id="a47cae3df6a3252c769244946890e430f"></a><!-- doxytag: member="bmqt::QueueOptions::setSuspendsOnBadHostHealth" ref="a47cae3df6a3252c769244946890e430f" args="(bool value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a>&amp; bmqt::QueueOptions::setSuspendsOnBadHostHealth </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>value</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set whether the queue suspends operation while host is unhealthy. </p>

</div>
</div>
<a class="anchor" id="a0047c64c5664f6d4aca4f89ec3471c40"></a><!-- doxytag: member="bmqt::QueueOptions::merge" ref="a0047c64c5664f6d4aca4f89ec3471c40" args="(const QueueOptions &amp;other)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a>&amp; bmqt::QueueOptions::merge </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>other</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>"Merges" another <code><a class="el" href="classbmqt_1_1QueueOptions.html">QueueOptions</a></code> into this one, by invoking setF(other.F()) for all fields <code>F</code> for which <code>other.hasF()</code> is true. Returns the instance on which the method was invoked. </p>

</div>
</div>
<a class="anchor" id="a2b19890736f81ae192ab0bdad5192284"></a><!-- doxytag: member="bmqt::QueueOptions::addOrUpdateSubscription" ref="a2b19890736f81ae192ab0bdad5192284" args="(bsl::string *errorDescription, const SubscriptionHandle &amp;handle, const Subscription &amp;subscription)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool bmqt::QueueOptions::addOrUpdateSubscription </td>
          <td>(</td>
          <td class="paramtype">bsl::string *&nbsp;</td>
          <td class="paramname"> <em>errorDescription</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classbmqt_1_1SubscriptionHandle.html">SubscriptionHandle</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>handle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classbmqt_1_1Subscription.html">Subscription</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>subscription</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Add, or update if it exists, the specified <code>subscription</code> for the specified <code>handle</code>. Return true on success, otherwise return false and load the specified <code>errorDescription</code> with a description of the error. Note that <code>errorDescription</code> may be null if the caller does not care about getting error messages, but users are strongly encouraged to log error string if this API returns failure.</p>
<p>EXPERIMENTAL. Do not use until this feature is announced. </p>

</div>
</div>
<a class="anchor" id="ab15f2fcc557e49a769ad63489bc64a96"></a><!-- doxytag: member="bmqt::QueueOptions::removeSubscription" ref="ab15f2fcc557e49a769ad63489bc64a96" args="(const SubscriptionHandle &amp;handle)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool bmqt::QueueOptions::removeSubscription </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classbmqt_1_1SubscriptionHandle.html">SubscriptionHandle</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>handle</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return false if subscription does not exist.</p>
<p>EXPERIMENTAL. Do not use until this feature is announced. </p>

</div>
</div>
<a class="anchor" id="ae8715c8c8dde82a208aec81d1b23ac8b"></a><!-- doxytag: member="bmqt::QueueOptions::removeAllSubscriptions" ref="ae8715c8c8dde82a208aec81d1b23ac8b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void bmqt::QueueOptions::removeAllSubscriptions </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Remove all subscriptions.</p>
<p>EXPERIMENTAL. Do not use until this feature is announced. </p>

</div>
</div>
<a class="anchor" id="afefffe95ececcd836bf25a8ca81795d3"></a><!-- doxytag: member="bmqt::QueueOptions::maxUnconfirmedMessages" ref="afefffe95ececcd836bf25a8ca81795d3" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int bmqt::QueueOptions::maxUnconfirmedMessages </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Get the number for the maxUnconfirmedMessages parameter. </p>

</div>
</div>
<a class="anchor" id="af9ea60251d07f84aa5a0ef02689c391a"></a><!-- doxytag: member="bmqt::QueueOptions::maxUnconfirmedBytes" ref="af9ea60251d07f84aa5a0ef02689c391a" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int bmqt::QueueOptions::maxUnconfirmedBytes </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Get the number for the maxUnconfirmedBytes parameter. </p>

</div>
</div>
<a class="anchor" id="aa832b2acfb752a6b83a3af8974c2547b"></a><!-- doxytag: member="bmqt::QueueOptions::consumerPriority" ref="aa832b2acfb752a6b83a3af8974c2547b" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int bmqt::QueueOptions::consumerPriority </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Get the number for the consumerPriority parameter. </p>

</div>
</div>
<a class="anchor" id="a6d2c1d8572f5ec608f2dc3121a24c60c"></a><!-- doxytag: member="bmqt::QueueOptions::suspendsOnBadHostHealth" ref="a6d2c1d8572f5ec608f2dc3121a24c60c" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool bmqt::QueueOptions::suspendsOnBadHostHealth </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Get whether the queue suspends operation while host is unhealthy. </p>

</div>
</div>
<a class="anchor" id="a66954bd9a55ad76d630dae6c9d1ee203"></a><!-- doxytag: member="bmqt::QueueOptions::hasMaxUnconfirmedMessages" ref="a66954bd9a55ad76d630dae6c9d1ee203" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool bmqt::QueueOptions::hasMaxUnconfirmedMessages </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns whether <code>maxUnconfirmedMessages</code> has been set for this object, or whether it implicitly holds <code>k_DEFAULT_MAX_UNCONFIRMED_MESSAGES</code>. </p>

</div>
</div>
<a class="anchor" id="a5c2da6dca1f318ebcde64bd8cb07e87e"></a><!-- doxytag: member="bmqt::QueueOptions::hasMaxUnconfirmedBytes" ref="a5c2da6dca1f318ebcde64bd8cb07e87e" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool bmqt::QueueOptions::hasMaxUnconfirmedBytes </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns whether <code>maxUnconfirmedBytes</code> has been set for this object, or whether it implicitly holds <code>k_DEFAULT_MAX_UNCONFIRMED_BYTES</code>. </p>

</div>
</div>
<a class="anchor" id="a1ad5325eed0d04a642e83e9ca61d9459"></a><!-- doxytag: member="bmqt::QueueOptions::hasConsumerPriority" ref="a1ad5325eed0d04a642e83e9ca61d9459" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool bmqt::QueueOptions::hasConsumerPriority </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns whether <code>consumerPriority</code> has been set for this object, or whether it implicitly holds <code>k_DEFAULT_CONSUMER_PRIORITY</code>. </p>

</div>
</div>
<a class="anchor" id="ab9c911994c74f86d1b9d038c66f98016"></a><!-- doxytag: member="bmqt::QueueOptions::hasSuspendsOnBadHostHealth" ref="ab9c911994c74f86d1b9d038c66f98016" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool bmqt::QueueOptions::hasSuspendsOnBadHostHealth </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns whether <code>suspendsOnBadHostHealth</code> has been set for this object, or whether it implicitly holds <code>k_DEFAULT_SUSPENDS_ON_BAD_HOST_HEALTH</code>. </p>

</div>
</div>
<a class="anchor" id="a166fc25291cde329afbcbb1f2679fe6f"></a><!-- doxytag: member="bmqt::QueueOptions::loadSubscription" ref="a166fc25291cde329afbcbb1f2679fe6f" args="(Subscription *subscription, const SubscriptionHandle &amp;handle) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool bmqt::QueueOptions::loadSubscription </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classbmqt_1_1Subscription.html">Subscription</a> *&nbsp;</td>
          <td class="paramname"> <em>subscription</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classbmqt_1_1SubscriptionHandle.html">SubscriptionHandle</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>handle</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return false if subscription does not exist.</p>
<p>EXPERIMENTAL. Do not use until this feature is announced. </p>

</div>
</div>
<a class="anchor" id="a19d8ed9af8de3110a24e06943c24d75c"></a><!-- doxytag: member="bmqt::QueueOptions::loadSubscriptions" ref="a19d8ed9af8de3110a24e06943c24d75c" args="(SubscriptionsSnapshot *snapshot) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void bmqt::QueueOptions::loadSubscriptions </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classbmqt_1_1QueueOptions.html#a9c1e8d991cf21dbb0653f991cf2fa432">SubscriptionsSnapshot</a> *&nbsp;</td>
          <td class="paramname"> <em>snapshot</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Load all handles and subscriptions into the specified <code>snapshot</code>.</p>
<p>EXPERIMENTAL. Do not use until this feature is announced. </p>

</div>
</div>
<a class="anchor" id="a914fedf6006eb0d656ef62e35bbf32b6"></a><!-- doxytag: member="bmqt::QueueOptions::print" ref="a914fedf6006eb0d656ef62e35bbf32b6" args="(bsl::ostream &amp;stream, int level=0, int spacesPerLevel=4) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bsl::ostream&amp; bmqt::QueueOptions::print </td>
          <td>(</td>
          <td class="paramtype">bsl::ostream &amp;&nbsp;</td>
          <td class="paramname"> <em>stream</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>level</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>spacesPerLevel</em> = <code>4</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Format this object to the specified output <code>stream</code> at the (absolute value of) the optionally specified indentation <code>level</code> and return a reference to <code>stream</code>. If <code>level</code> is specified, optionally specify <code>spacesPerLevel</code>, the number of spaces per indentation level for this and all of its nested objects. If <code>level</code> is negative, suppress indentation of the first line. If <code>spacesPerLevel</code> is negative format the entire output on one line, suppressing all but the initial indentation (as governed by <code>level</code>). If <code>stream</code> is not valid on entry, this operation has no effect. </p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a38adf91bbaa3db9053f91f2379932948"></a><!-- doxytag: member="bmqt::QueueOptions::k_CONSUMER_PRIORITY_MIN" ref="a38adf91bbaa3db9053f91f2379932948" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const int <a class="el" href="classbmqt_1_1QueueOptions.html#a38adf91bbaa3db9053f91f2379932948">bmqt::QueueOptions::k_CONSUMER_PRIORITY_MIN</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a9a92dfabe30fb12dde00aa9303d7ed84"></a><!-- doxytag: member="bmqt::QueueOptions::k_CONSUMER_PRIORITY_MAX" ref="a9a92dfabe30fb12dde00aa9303d7ed84" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const int <a class="el" href="classbmqt_1_1QueueOptions.html#a9a92dfabe30fb12dde00aa9303d7ed84">bmqt::QueueOptions::k_CONSUMER_PRIORITY_MAX</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aabe15a2964a14ff88ee44341f72c416a"></a><!-- doxytag: member="bmqt::QueueOptions::k_DEFAULT_MAX_UNCONFIRMED_MESSAGES" ref="aabe15a2964a14ff88ee44341f72c416a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const int <a class="el" href="classbmqt_1_1QueueOptions.html#aabe15a2964a14ff88ee44341f72c416a">bmqt::QueueOptions::k_DEFAULT_MAX_UNCONFIRMED_MESSAGES</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a9f6446c7c8924842bab804fe66905fac"></a><!-- doxytag: member="bmqt::QueueOptions::k_DEFAULT_MAX_UNCONFIRMED_BYTES" ref="a9f6446c7c8924842bab804fe66905fac" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const int <a class="el" href="classbmqt_1_1QueueOptions.html#a9f6446c7c8924842bab804fe66905fac">bmqt::QueueOptions::k_DEFAULT_MAX_UNCONFIRMED_BYTES</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="adfa0750ed97f9aea50c5f1f3125d4e00"></a><!-- doxytag: member="bmqt::QueueOptions::k_DEFAULT_CONSUMER_PRIORITY" ref="adfa0750ed97f9aea50c5f1f3125d4e00" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const int <a class="el" href="classbmqt_1_1QueueOptions.html#adfa0750ed97f9aea50c5f1f3125d4e00">bmqt::QueueOptions::k_DEFAULT_CONSUMER_PRIORITY</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aaa822bd525767bd9f5cc6ec35cb55db3"></a><!-- doxytag: member="bmqt::QueueOptions::k_DEFAULT_SUSPENDS_ON_BAD_HOST_HEALTH" ref="aaa822bd525767bd9f5cc6ec35cb55db3" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const bool <a class="el" href="classbmqt_1_1QueueOptions.html#aaa822bd525767bd9f5cc6ec35cb55db3">bmqt::QueueOptions::k_DEFAULT_SUSPENDS_ON_BAD_HOST_HEALTH</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="bmqt__queueoptions_8h_source.html">bmqt_queueoptions.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jun 15 2023 11:58:51 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
